Skip to content
This repository has been archived by the owner on Apr 15, 2024. It is now read-only.

docs: metrics documentation #675

Merged
merged 3 commits into from
Jan 3, 2024
Merged

docs: metrics documentation #675

merged 3 commits into from
Jan 3, 2024

Conversation

rach-id
Copy link
Member

@rach-id rach-id commented Jan 3, 2024 •
edited by coderabbitai bot
Loading

Overview

Documentation for metrics in #674

Checklist

  • New and updated code has appropriate documentation
  • New and updated code has new and/or updated testing
  • Required CI checks are passing
  • Visual proof for any user facing features like CLI or documentation updates
  • Linked issues closed with keywords

Summary by CodeRabbit

  • Documentation
    • Updated orchestrator documentation to include details on new telemetry support and metrics.
    • Added instructions for enabling and configuring telemetry in the orchestrator.
    • Enhanced relayer documentation with information on telemetry metrics and setup instructions.

@rach-id rach-id added the documentation Improvements or additions to documentation label Jan 3, 2024
@rach-id rach-id self-assigned this Jan 3, 2024
@rach-id rach-id requested a review from evan-forbes as a code owner January 3, 2024 17:09
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 3, 2024 •
edited
Loading

Walkthrough

The recent updates introduce telemetry support for both the orchestrator and relayer components, with new metrics for processed nonces, failures, and processing times. These metrics can be enabled in the configuration files and reported to an otel collector. Additionally, LibP2P native metrics are provided for the orchestrator when enabled.

Changes

File Pattern Change Summary
docs/orchestrator.md Added telemetry support with new metrics, otel collector integration, and example configurations.
docs/relayer.md Introduced telemetry metrics, instructions for enabling them, and otel collector endpoint setup.

🐇✨
To measure and to know,
Our data now will show.
Timely hops through code,
Metrics now on the road. 📊🚀

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • You can directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • You can tag CodeRabbit on specific lines of code or entire files in the PR by tagging @coderabbitai in a comment. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • You can tag @coderabbitai in a PR comment and ask questions about the PR and the codebase. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid.
    • @coderabbitai read the files in the src/scheduler package and generate README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

coderabbitai[bot]
coderabbitai bot reviewed Jan 3, 2024
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 3

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 922d0e5 and e8152d8.
Files selected for processing (2)
  • docs/orchestrator.md (1 hunks)
  • docs/relayer.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • docs/relayer.md

docs/orchestrator.md Outdated Show resolved Hide resolved
docs/orchestrator.md Outdated Show resolved Hide resolved
docs/orchestrator.md Show resolved Hide resolved
@codecov-commenter
Copy link

codecov-commenter commented Jan 3, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (922d0e5) 24.56% compared to head (47b11f9) 24.56%.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #675   +/-   ##
=======================================
  Coverage   24.56%   24.56%           
=======================================
  Files          29       29           
  Lines        3212     3212           
=======================================
  Hits          789      789           
  Misses       2328     2328           
  Partials       95       95

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

coderabbitai[bot]
coderabbitai bot reviewed Jan 3, 2024
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 4

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between e8152d8 and 47b11f9.
Files selected for processing (2)
  • docs/orchestrator.md (1 hunks)
  • docs/relayer.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • docs/orchestrator.md

docs/relayer.md Show resolved Hide resolved
docs/relayer.md Show resolved Hide resolved
docs/relayer.md Show resolved Hide resolved
evan-forbes
evan-forbes approved these changes Jan 3, 2024
View reviewed changes
Copy link
Member

@evan-forbes evan-forbes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

really great! thanks for taking the extra time to explain these

docs/relayer.md

And setup a correct endpoint to connect to an [otel collector](https://opentelemetry.io/docs/collector/installation/), by default it targets the `"localhost:4318"` endpoint. These can also be setup using the command line flags.

The relayer provides also the LibP2P native metrics. These are also enabled when the above parameter is set to `true` and are served, by default, to the `"localhost:30001/metrics"`, which can be updated using the relayer config file or the command line flags.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@rach-id rach-id merged commit 754f500 into celestiaorg:main Jan 3, 2024
18 checks passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@evan-forbes evan-forbes evan-forbes approved these changes

Assignees

@rach-id rach-id

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rach-id @codecov-commenter @evan-forbes